Salt simulation elements #8
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…k together with the salt simulation mixin.
k-horvath-deltares
force-pushed
the
salt-simulation-elements
branch
from
3ca71f5 to
de38b4f
Compare
There was a problem hiding this comment.
Pull request overview
This PR introduces salt simulation capabilities to the RTC-Tools Channel Flow package by adding a new Salt package containing elements for modeling advective and dispersive salt transport in water systems. These components are designed to work with the salt_simulation_mixin from the rtc-tools-simulation package and are intended for simulation only, not optimization.
Key changes:
- Added new
Saltpackage with reservoir, node, and structure elements for salt transport modeling - Implemented UNESCO EOS-80 equation for seawater density calculations based on salinity and temperature
- Created specialized forcing and storage elements supporting mass transport alongside volume flow
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| package.order (ChannelFlow) | Registered new Salt package in module hierarchy |
| Salt/package.mo | Root package definition for salt simulation components |
| Salt/package.order | Declared Elements subpackage |
| Salt/Elements/package.mo | Elements subpackage definition |
| Salt/Elements/package.order | Listed all salt simulation element classes |
| SubstanceControlledStructure.mo | Structure element implementing density-driven flow with UNESCO EOS-80 calculations |
| SaltyPartialStorage.mo | Base class for storage elements with mass balance |
| SaltyPartialReservoirBnd.mo | Boundary reservoir base class (zero derivatives) |
| SaltyPartialReservoir.mo | Standard reservoir base class with mass and volume conservation |
| SaltyLinearReservoirBnd.mo | Linear reservoir boundary implementation |
| SaltyLinearReservoir.mo | Linear reservoir implementation with forcing |
| QMForcing.mo | Forcing class for volume and mass flow inputs |
| NodeSalty.mo | Node element connecting reservoirs with mass conservation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| model SubstanceControlledStructure "SubstanceControlledStructure" | ||
| /* | ||
| This block is designed to be used together with the "salt_simulation_mixin" to calculate dispersive and advective transport | ||
| between salty reservoir elements, do not user in optimization. |
There was a problem hiding this comment.
Corrected spelling of 'user' to 'use'.
Suggested change
| between salty reservoir elements, do not user in optimization. | |
| between salty reservoir elements, do not use in optimization. |
| partial model SaltyPartialStorage | ||
| /* | ||
| This block is designed to be used together with the "salt_simulation_mixin" to calculate dispersive and advective transport | ||
| between salty reservoir elements, do not user in optimization. |
There was a problem hiding this comment.
Corrected spelling of 'user' to 'use'.
Suggested change
| between salty reservoir elements, do not user in optimization. | |
| between salty reservoir elements, do not use in optimization. |
| model SaltyLinearReservoirBnd | ||
| /* | ||
| This block is designed to be used together with the "salt_simulation_mixin" to calculate dispersive and advective transport | ||
| between salty reservoir elements, do not user in optimization. |
There was a problem hiding this comment.
Corrected spelling of 'user' to 'use'.
Suggested change
| between salty reservoir elements, do not user in optimization. | |
| between salty reservoir elements, do not use in optimization. |
| model SaltyLinearReservoir | ||
| /* | ||
| This block is designed to be used together with the "salt_simulation_mixin" to calculate dispersive and advective transport | ||
| between salty reservoir elements, do not user in optimization. |
There was a problem hiding this comment.
Corrected spelling of 'user' to 'use'.
Suggested change
| between salty reservoir elements, do not user in optimization. | |
| between salty reservoir elements, do not use in optimization. |
| model NodeSalty | ||
| /* | ||
| This block is designed to be used together with the "salt_simulation_mixin" to calculate dispersive and advective transport | ||
| between salty reservoir elements, do not user in optimization. |
There was a problem hiding this comment.
Corrected spelling of 'user' to 'use'.
Suggested change
| between salty reservoir elements, do not user in optimization. | |
| between salty reservoir elements, do not use in optimization. |
| parameter Integer n_QForcing(min = 0) = 0; | ||
| replaceable package medium = Deltares.ChannelFlow.Media.FreshWater; | ||
| input SI.VolumeFlowRate QForcing[n_QForcing]; | ||
| input SI.VolumeFlowRate MForcing[n_QForcing]; |
There was a problem hiding this comment.
The variable MForcing represents mass flow rate but is typed as VolumeFlowRate. Consider using SI.MassFlowRate for MForcing to accurately reflect the physical quantity.
Suggested change
| input SI.VolumeFlowRate MForcing[n_QForcing]; | |
| input SI.MassFlowRate MForcing[n_QForcing]; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This branch contains blocks that are used to model advective and dispersive salt transport. They are only used in simulation, together with salt_simulation_mixin from the rtc-tools-simulation package.